﻿/*----------------------------------------------------------------
//  <copyright file="IOrganizationStore.cs" company="MicroCloud@151504200868">
//      Copyright © 2020-2024 MicroCloud Corporation, All rights reserved.
//  </copyright>
//  <site>https://gitee.com/chenmm123/microclouds</site>
//  <last-editor>cmm</last-editor>
//  <last-date>2023-09-21 09:42</last-date>
//----------------------------------------------------------------*/

namespace MicroCloud.Identity
{
    #region "为组织机构的存储和管理提供抽象"
    /// <summary>
    /// 为组织机构的存储和管理提供抽象
    /// </summary>
    /// <typeparam name="TOrganization">组织机构实体类型</typeparam>
    public interface IOrganizationStore<TOrganization> : IDisposable where TOrganization : class
    {
        #region "方法"
        #region "检查组织机构信息是否存在"
        /// <summary>
        /// 检查组织机构信息是否存在
        /// </summary>
        /// <param name="predicate">检查谓语表达式</param>
        /// <param name="organizationId">组织机构编号</param>
        /// <returns>组织机构是否存在</returns>
        bool CheckOrganizationExists(Expression<Func<TOrganization, bool>> predicate, string organizationId = default);
        #endregion
        #region "在存储中创建一个新组织机构"
        /// <summary>
        /// 在存储中创建一个新组织机构
        /// </summary>
        /// <param name="organization">要在存储中创建的组织机构</param>
        /// <returns>表示一个 <see cref="OperationResult" /> </returns>
        OperationResult Create(TOrganization organization);
        #endregion
        #region "更新存储中的组织机构"
        /// <summary>
        /// 更新存储中的组织机构
        /// </summary>
        /// <param name="organization">要在存储中更新的组织机构</param>
        /// <returns>表示一个 <see cref="OperationResult" /> </returns>
        OperationResult Update(TOrganization organization);
        #endregion
        #region "删除存储中的组织机构"
        /// <summary>
        /// 删除存储中的组织机构
        /// </summary>
        /// <param name="organizationId">组织机构编号</param>
        /// <returns>表示一个 <see cref="OperationResult" /> </returns>
        OperationResult Delete(string organizationId);
        #endregion
        #region "删除存储中的组织机构"
        /// <summary>
        /// 删除存储中的组织机构
        /// </summary>
        /// <param name="organization">组织机构实体</param>
        /// <returns><see cref="Task" /> 表示一个异步的 <see cref="OperationResult" /> </returns>
        OperationResult Delete(TOrganization organization);
        #endregion
        #region "查找具有指定ID的组织机构"
        /// <summary>
        /// 查找具有指定ID的组织机构
        /// </summary>
        /// <param name="organizationId">要查找的组织机构编号</param>
        /// <returns>组织机构结果</returns>
        TOrganization FindById(string organizationId);
        #endregion
        #region "获取子级组织机构集合"
        /// <summary>
        /// 获取子级组织机构集合
        /// </summary>
        /// <param name="organizationId">组织机构编号</param>
        /// <returns>子级组织机构集合</returns>
        OrganizationDtoSimple[] GetChildOrganizations(string organizationId);
        #endregion
        #region "获取父级组织机构集合"
        /// <summary>
        /// 获取父级组织机构集合
        /// </summary>
        /// <param name="organizationId">组织机构编号</param>
        /// <returns>父级组织机构集合</returns>
        OrganizationDtoSimple[] GetParentOrganizations(string organizationId);
        #endregion

        #region "异步检查组织机构信息是否存在"
        /// <summary>
        /// 异步检查组织机构信息是否存在
        /// </summary>
        /// <param name="predicate">检查谓语表达式</param>
        /// <param name="organizationId">组织机构编号</param>
        /// <returns>组织机构是否存在</returns>
        Task<bool> CheckOrganizationExistsAsync(Expression<Func<TOrganization, bool>> predicate, string organizationId = default);
        #endregion
        #region "异步在存储中创建一个新组织机构"
        /// <summary>
        /// 异步在存储中创建一个新组织机构
        /// </summary>
        /// <param name="organization">要在存储中创建的组织机构</param>
        /// <param name="cancellationToken"><see cref="CancellationToken" /> 用于传播应取消操作的通知</param>
        /// <returns><see cref="Task" /> 表示一个异步的 <see cref="OperationResult" /> </returns>
        Task<OperationResult> CreateAsync(TOrganization organization, CancellationToken cancellationToken = new CancellationToken());
        #endregion
        #region "异步更新存储中的组织机构"
        /// <summary>
        /// 异步更新存储中的组织机构
        /// </summary>
        /// <param name="organization">要在存储中更新的组织机构</param>
        /// <param name="cancellationToken"><see cref="CancellationToken" /> 用于传播应取消操作的通知</param>
        /// <returns><see cref="Task" /> 表示一个异步的 <see cref="OperationResult" /></returns>
        Task<OperationResult> UpdateAsync(TOrganization organization, CancellationToken cancellationToken = new CancellationToken());
        #endregion
        #region "异步删除存储中的组织机构"
        /// <summary>
        /// 异步删除存储中的组织机构
        /// </summary>
        /// <param name="organizationId">组织机构编号</param>
        /// <param name="cancellationToken"><see cref="CancellationToken" /> 用于传播应取消操作的通知</param>
        /// <returns><see cref="Task" /> 表示一个异步的 <see cref="OperationResult" /></returns>
        Task<OperationResult> DeleteAsync(string organizationId, CancellationToken cancellationToken = new CancellationToken());
        #endregion
        #region "异步删除存储中的组织机构"
        /// <summary>
        /// 异步删除存储中的组织机构
        /// </summary>
        /// <param name="organization">组织机构实体</param>
        /// <param name="cancellationToken"><see cref="CancellationToken" /> 用于传播应取消操作的通知</param>
        /// <returns><see cref="Task" /> 表示一个异步的 <see cref="OperationResult" /></returns>
        Task<OperationResult> DeleteAsync(TOrganization organization, CancellationToken cancellationToken = new CancellationToken());
        #endregion
        #region "异步查找具有指定ID的组织机构"
        /// <summary>
        /// 异步查找具有指定ID的组织机构
        /// </summary>
        /// <param name="organizationId">要查找的组织机构编号</param>
        /// <param name="cancellationToken"><see cref="CancellationToken" /> 用于传播应取消操作的通知</param>
        /// <returns>包含组织机构的 <see cref="Task" /> 结果</returns>
        Task<TOrganization> FindByIdAsync(string organizationId, CancellationToken cancellationToken = new CancellationToken());
        #endregion
        #region "异步获取子级组织机构集合"
        /// <summary>
        /// 异步获取子级组织机构集合
        /// </summary>
        /// <param name="organizationId">组织机构编号</param>
        /// <returns>子级组织机构集合</returns>
        Task<OrganizationDtoSimple[]> GetChildOrganizationsAsync(string organizationId);
        #endregion
        #region "异步获取父级组织机构集合"
        /// <summary>
        /// 异步获取父级组织机构集合
        /// </summary>
        /// <param name="organizationId">组织机构编号</param>
        /// <returns>父级组织机构集合</returns>
        Task<OrganizationDtoSimple[]> GetParentOrganizationsAsync(string organizationId);
        #endregion

        #region "规范化组织机构名称以进行一致的比较"
        /// <summary>
        /// 规范化组织机构名称以进行一致的比较
        /// </summary>
        /// <param name="organizationName">组织机构名称</param>
        /// <returns>规范化的组织机构名称</returns>
        string NormalizeName(string organizationName);
        #endregion

        #region "获取树节点及其子节点的所有组织机构编号"
        /// <summary>
        /// 获取树节点及其子节点的所有组织机构编号
        /// </summary>
        /// <param name="rootIds">树节点</param>
        /// <returns>组织机构编号集合</returns>
        string[] GetTreeIds(params string[] rootIds);
        #endregion

        #region "获取组织机构树形数据"
        /// <summary>
        /// 获取组织机构树形数据
        /// </summary>
        /// <param name="organizationIds">组织机构编号</param>
        /// <returns>组织机构树形数据</returns>
        OrganizationTreeNode[] GetTreeNodes(params string[] organizationIds);
        #endregion

        #endregion

    }
    #endregion

}
